<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: WebContextApplicationServlet.html 61 2011-03-10 15:40:08Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.stuff.vaadin;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import com.vaadin.Application;<a name="line.10"></a>
<FONT color="green">011</FONT>    import com.vaadin.terminal.gwt.server.ApplicationServlet;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    import javax.servlet.ServletConfig;<a name="line.13"></a>
<FONT color="green">014</FONT>    import javax.servlet.ServletException;<a name="line.14"></a>
<FONT color="green">015</FONT>    import javax.servlet.http.HttpServletRequest;<a name="line.15"></a>
<FONT color="green">016</FONT>    <a name="line.16"></a>
<FONT color="green">017</FONT>    import org.slf4j.Logger;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.slf4j.LoggerFactory;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.springframework.beans.BeansException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.springframework.web.context.WebApplicationContext;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.springframework.web.context.support.WebApplicationContextUtils;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    /**<a name="line.23"></a>
<FONT color="green">024</FONT>     * {@link ApplicationServlet} that acquires {@link Application} instances from an<a name="line.24"></a>
<FONT color="green">025</FONT>     * associated Spring {@link WebApplicationContext}.<a name="line.25"></a>
<FONT color="green">026</FONT>     * This allows a Vaadin application to be configured as a normal bean inside<a name="line.26"></a>
<FONT color="green">027</FONT>     * a Spring application context, where annotations such as<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;code&gt;{@link org.springframework.beans.factory.annotation.Autowired @Autowired}&lt;/code&gt;,<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;code&gt;{@link org.springframework.beans.factory.annotation.Required @Required}&lt;/code&gt;, etc.<a name="line.29"></a>
<FONT color="green">030</FONT>     * and interfaces such as {@link org.springframework.beans.factory.BeanFactoryAware BeanFactoryAware},<a name="line.30"></a>
<FONT color="green">031</FONT>     * etc. will work.<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;/p&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     *<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;p&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     * Important: The application bean must be declared in the associated {@link WebApplicationContext}<a name="line.35"></a>
<FONT color="green">036</FONT>     * with &lt;code&gt;scope="prototype"&lt;/code&gt; (or &lt;code&gt;scope="session"&lt;/code&gt; if you prefer), and it must be<a name="line.36"></a>
<FONT color="green">037</FONT>     * the only instance of the configured application class.<a name="line.37"></a>
<FONT color="green">038</FONT>     * &lt;/p&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     *<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * An example of "direct" use of this servlet in conjunction with Spring's<a name="line.41"></a>
<FONT color="green">042</FONT>     * {@link org.springframework.web.context.ContextLoaderListener ContextLoaderListener}:<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     *  &amp;lt;!-- Spring context loader --&amp;gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     *  &amp;lt;listener&amp;gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     *      &amp;lt;listener-class&amp;gt;org.springframework.web.context.ContextLoaderListener&amp;lt;/listener-class&amp;gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     *  &amp;lt;/listener&amp;gt;<a name="line.47"></a>
<FONT color="green">048</FONT>     *<a name="line.48"></a>
<FONT color="green">049</FONT>     *  &amp;lt;!-- Spring web request listener: makes the current web request available in a private ThreadLocal --&amp;gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     *  &amp;lt;listener&amp;gt;<a name="line.50"></a>
<FONT color="green">051</FONT>     *      &amp;lt;listener-class&amp;gt;org.springframework.web.context.request.RequestContextListener&amp;lt;/listener-class&amp;gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     *  &amp;lt;/listener&amp;gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     *<a name="line.53"></a>
<FONT color="green">054</FONT>     *  &amp;lt;!-- Vaadin servlet --&amp;gt;<a name="line.54"></a>
<FONT color="green">055</FONT>     *  &amp;lt;servlet&amp;gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     *      &amp;lt;servlet-name&amp;gt;myapp&amp;lt;/servlet-name&amp;gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     *      &amp;lt;servlet-class&amp;gt;org.dellroad.stuff.vaadin.WebContextApplicationServlet&amp;lt;/servlet-class&amp;gt;<a name="line.57"></a>
<FONT color="green">058</FONT>     *      &amp;lt;init-param&amp;gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     *          &amp;lt;param-name&amp;gt;application&amp;lt;/param-name&amp;gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     *          &amp;lt;param-value&amp;gt;some.spring.configured.Application&amp;lt;/param-value&amp;gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     *      &amp;lt;/init-param&amp;gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     *      &amp;lt;init-param&amp;gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     *          &amp;lt;param-name&amp;gt;productionMode&amp;lt;/param-name&amp;gt;<a name="line.63"></a>
<FONT color="green">064</FONT>     *          &amp;lt;param-value&amp;gt;true&amp;lt;/param-value&amp;gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     *      &amp;lt;/init-param&amp;gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     *  &amp;lt;/servlet&amp;gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     *  &amp;lt;servlet-mapping&amp;gt;<a name="line.67"></a>
<FONT color="green">068</FONT>     *      &amp;lt;servlet-name&amp;gt;myapp&amp;lt;/servlet-name&amp;gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     *      &amp;lt;url-pattern&amp;gt;/*&amp;lt;/url-pattern&amp;gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     *  &amp;lt;/servlet-mapping&amp;gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.71"></a>
<FONT color="green">072</FONT>     * with this application context:<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *  &amp;lt;!-- Activate Spring annotation support --&amp;gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *  &amp;lt;context:annotation-config/&amp;gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     *<a name="line.76"></a>
<FONT color="green">077</FONT>     *  &amp;lt;!-- Define Vaadin application bean --&amp;gt;<a name="line.77"></a>
<FONT color="green">078</FONT>     *  &amp;lt;bean class="some.spring.configured.Application" scope="prototype"/&amp;gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     *<a name="line.79"></a>
<FONT color="green">080</FONT>     *  &amp;lt;!-- Define other beans... --&amp;gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     * &lt;/p&gt;<a name="line.82"></a>
<FONT color="green">083</FONT>     *<a name="line.83"></a>
<FONT color="green">084</FONT>     * &lt;p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     * An example that creates a Spring MVC "controller" bean for use with Spring's<a name="line.85"></a>
<FONT color="green">086</FONT>     * {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}:<a name="line.86"></a>
<FONT color="green">087</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     *  &amp;lt;!-- Activate Spring annotation support --&amp;gt;<a name="line.88"></a>
<FONT color="green">089</FONT>     *  &amp;lt;context:annotation-config/&amp;gt;<a name="line.89"></a>
<FONT color="green">090</FONT>     *<a name="line.90"></a>
<FONT color="green">091</FONT>     *  &amp;lt;!-- Define controller bean for Vaadin application --&amp;gt;<a name="line.91"></a>
<FONT color="green">092</FONT>     *  &amp;lt;bean id="applicationController" class="org.springframework.web.servlet.mvc.ServletWrappingController"<a name="line.92"></a>
<FONT color="green">093</FONT>     *     p:servletClass="org.dellroad.stuff.vaadin.WebContextApplicationServlet"&amp;gt;<a name="line.93"></a>
<FONT color="green">094</FONT>     *      &amp;lt;property name="initParameters"&amp;gt;<a name="line.94"></a>
<FONT color="green">095</FONT>     *          &amp;lt;props&amp;gt;<a name="line.95"></a>
<FONT color="green">096</FONT>     *              &amp;lt;prop key="application"&amp;gt;some.spring.configured.Application&amp;lt;/prop&amp;gt;<a name="line.96"></a>
<FONT color="green">097</FONT>     *              &amp;lt;prop key="productionMode"&amp;gt;true&amp;lt;/prop&amp;gt;<a name="line.97"></a>
<FONT color="green">098</FONT>     *          &amp;lt;/props&amp;gt;<a name="line.98"></a>
<FONT color="green">099</FONT>     *      &amp;lt;/property&amp;gt;<a name="line.99"></a>
<FONT color="green">100</FONT>     *  &amp;lt;/bean&amp;gt;<a name="line.100"></a>
<FONT color="green">101</FONT>     *<a name="line.101"></a>
<FONT color="green">102</FONT>     *  &amp;lt;!-- Define Vaadin application bean --&amp;gt;<a name="line.102"></a>
<FONT color="green">103</FONT>     *  &amp;lt;bean class="some.spring.configured.Application" scope="prototype"/&amp;gt;<a name="line.103"></a>
<FONT color="green">104</FONT>     *<a name="line.104"></a>
<FONT color="green">105</FONT>     *  &amp;lt;!-- Define other beans... --&amp;gt;<a name="line.105"></a>
<FONT color="green">106</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.106"></a>
<FONT color="green">107</FONT>     *<a name="line.107"></a>
<FONT color="green">108</FONT>     * @see org.springframework.web.servlet.mvc.ContextLoaderListener<a name="line.108"></a>
<FONT color="green">109</FONT>     * @see org.springframework.web.servlet.DispatcherServlet<a name="line.109"></a>
<FONT color="green">110</FONT>     * @see org.springframework.web.servlet.mvc.ServletWrappingController<a name="line.110"></a>
<FONT color="green">111</FONT>     * @see WebApplicationContext<a name="line.111"></a>
<FONT color="green">112</FONT>     * @since 1.0.50<a name="line.112"></a>
<FONT color="green">113</FONT>     */<a name="line.113"></a>
<FONT color="green">114</FONT>    @SuppressWarnings("serial")<a name="line.114"></a>
<FONT color="green">115</FONT>    public class WebContextApplicationServlet extends ApplicationServlet {<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        protected final Logger log = LoggerFactory.getLogger(getClass());<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        private WebApplicationContext webApplicationContext;<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>        /**<a name="line.121"></a>
<FONT color="green">122</FONT>         * Initialize this servlet.<a name="line.122"></a>
<FONT color="green">123</FONT>         *<a name="line.123"></a>
<FONT color="green">124</FONT>         * @throws ServletException if there is no {@link WebApplicationContext} associated with this servlet's context<a name="line.124"></a>
<FONT color="green">125</FONT>         */<a name="line.125"></a>
<FONT color="green">126</FONT>        @Override<a name="line.126"></a>
<FONT color="green">127</FONT>        public void init(ServletConfig config) throws ServletException {<a name="line.127"></a>
<FONT color="green">128</FONT>            super.init(config);<a name="line.128"></a>
<FONT color="green">129</FONT>            log.debug("finding containing WebApplicationContext");<a name="line.129"></a>
<FONT color="green">130</FONT>            try {<a name="line.130"></a>
<FONT color="green">131</FONT>                this.webApplicationContext = WebApplicationContextUtils.getRequiredWebApplicationContext(config.getServletContext());<a name="line.131"></a>
<FONT color="green">132</FONT>            } catch (IllegalStateException e) {<a name="line.132"></a>
<FONT color="green">133</FONT>                throw new ServletException("could not locate containing WebApplicationContext");<a name="line.133"></a>
<FONT color="green">134</FONT>            }<a name="line.134"></a>
<FONT color="green">135</FONT>        }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>        /**<a name="line.137"></a>
<FONT color="green">138</FONT>         * Get the containing Spring {@link WebApplicationContext}.<a name="line.138"></a>
<FONT color="green">139</FONT>         * This only works after the servlet has been initialized (via {@link #init init()}).<a name="line.139"></a>
<FONT color="green">140</FONT>         *<a name="line.140"></a>
<FONT color="green">141</FONT>         * @throws ServletException if the operation fails<a name="line.141"></a>
<FONT color="green">142</FONT>         */<a name="line.142"></a>
<FONT color="green">143</FONT>        protected final WebApplicationContext getWebApplicationContext() throws ServletException {<a name="line.143"></a>
<FONT color="green">144</FONT>            if (this.webApplicationContext == null)<a name="line.144"></a>
<FONT color="green">145</FONT>                throw new ServletException("can't retrieve WebApplicationContext before init() is invoked");<a name="line.145"></a>
<FONT color="green">146</FONT>            return this.webApplicationContext;<a name="line.146"></a>
<FONT color="green">147</FONT>        }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>        /**<a name="line.149"></a>
<FONT color="green">150</FONT>         * Create and configure a new instance of the configured application class.<a name="line.150"></a>
<FONT color="green">151</FONT>         *<a name="line.151"></a>
<FONT color="green">152</FONT>         * &lt;p&gt;<a name="line.152"></a>
<FONT color="green">153</FONT>         * The implementation in {@link WebContextApplicationServlet} invokes<a name="line.153"></a>
<FONT color="green">154</FONT>         * {@link org.springframework.beans.factory.BeanFactory#getBean(Class) BeanFactory.getBean()}<a name="line.154"></a>
<FONT color="green">155</FONT>         * on the associated {@link WebApplicationContext} class to acquire an instance of the class<a name="line.155"></a>
<FONT color="green">156</FONT>         * configured via the {@code application} servlet parameter.<a name="line.156"></a>
<FONT color="green">157</FONT>         * &lt;/p&gt;<a name="line.157"></a>
<FONT color="green">158</FONT>         *<a name="line.158"></a>
<FONT color="green">159</FONT>         * @param request the triggering {@link HttpServletRequest}<a name="line.159"></a>
<FONT color="green">160</FONT>         * @throws ServletException if bean creation fails<a name="line.160"></a>
<FONT color="green">161</FONT>         */<a name="line.161"></a>
<FONT color="green">162</FONT>        @Override<a name="line.162"></a>
<FONT color="green">163</FONT>        protected Application getNewApplication(HttpServletRequest request) throws ServletException {<a name="line.163"></a>
<FONT color="green">164</FONT>            Class&lt;? extends Application&gt; applicationClass;<a name="line.164"></a>
<FONT color="green">165</FONT>            try {<a name="line.165"></a>
<FONT color="green">166</FONT>                applicationClass = this.getApplicationClass();<a name="line.166"></a>
<FONT color="green">167</FONT>            } catch (ClassNotFoundException e) {<a name="line.167"></a>
<FONT color="green">168</FONT>                throw new ServletException("failed to create new instance of application class", e);<a name="line.168"></a>
<FONT color="green">169</FONT>            }<a name="line.169"></a>
<FONT color="green">170</FONT>            log.debug("acquiring new instance of " + applicationClass + " from " + this.webApplicationContext);<a name="line.170"></a>
<FONT color="green">171</FONT>            try {<a name="line.171"></a>
<FONT color="green">172</FONT>                return this.getWebApplicationContext().getBean(applicationClass);<a name="line.172"></a>
<FONT color="green">173</FONT>            } catch (BeansException e) {<a name="line.173"></a>
<FONT color="green">174</FONT>                throw new ServletException("failed to acquire new instance of " + applicationClass, e);<a name="line.174"></a>
<FONT color="green">175</FONT>            }<a name="line.175"></a>
<FONT color="green">176</FONT>        }<a name="line.176"></a>
<FONT color="green">177</FONT>    }<a name="line.177"></a>
<FONT color="green">178</FONT>    <a name="line.178"></a>




























































</PRE>
</BODY>
</HTML>
